[PLAT-7126] Stop dropping breadcrumbs with invalid metadata #1187
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Goal
Stop dropping breadcrumbs when invalid metadata is provided by the app / developer.
Changeset
Documentation for
leaveBreadcrumbWithMessage:metadata:andType:has been added to clarify that metadata should contain only valid JSON (i.e. convertible byNSJSONSerialization.)Breadcrumb metadata is now converted to valid JSON if required by replacing invalid objects with their descriptions, and an explicit warning is logged.
Testing
Amended existing unit tests to verify this change in behaviour.